home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / os2 / tmail.zip / JFRQ103D.ZIP / JFREQ103.RAR / JFREQ.DOC < prev    next >
Text File  |  1996-06-22  |  42KB  |  1,036 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                    - - - - -
  8.                                    J F R e q
  9.                                    - - - - -
  10.  
  11.  
  12.            External File Request Processor for FrontDoor, MainDoor,
  13.        Intermail or compatible mailers & Remote Access, Maximus, or any
  14.                    BBS system based on a FILES.BBS structure
  15.  
  16.  
  17.                   (C) 1994-96 Jordi Sese (Fidonet 2:343/116)
  18.  
  19.  
  20.                                  version 1.03
  21.  
  22.  
  23.  
  24.  
  25.                                    IMPORTANT
  26.      This program IS NOT, public domain. It is a Shareware Product. Please
  27.       read the document REGISTER.TXT to know about its conditions of use
  28.  
  29.  
  30.  
  31.  
  32.  
  33.                                Table of Contents
  34.  
  35.  
  36.  
  37.   1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  38.     1.1 What is a File Request Processor? . . . . . . . . . . . . . . . . . 1
  39.     1.2 Features of JFReq 1.03  . . . . . . . . . . . . . . . . . . . . . . 1
  40.     1.3 Files in the distribution package . . . . . . . . . . . . . . . . . 2
  41.  
  42.   2. Setup  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  43.     2.1 UPGRADING from version 1.00 . . . . . . . . . . . . . . . . . . . . 3
  44.     2.2 UPGRADING from version 1.01 . . . . . . . . . . . . . . . . . . . . 3
  45.     2.3 UPGRADING from version 1.02 . . . . . . . . . . . . . . . . . . . . 3
  46.     2.4 General Installation Notes  . . . . . . . . . . . . . . . . . . . . 3
  47.     2.5 Multiline systems . . . . . . . . . . . . . . . . . . . . . . . . . 4
  48.     2.6 Environment Variables . . . . . . . . . . . . . . . . . . . . . . . 4
  49.     2.7 Mailer Setup  . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
  50.       2.7.1 MainDoor & MainDoor/2 . . . . . . . . . . . . . . . . . . . . . 5
  51.       2.7.2 FrontDoor 2.1x & 2.2x . . . . . . . . . . . . . . . . . . . . . 5
  52.       2.7.3 Intermail 2.27  . . . . . . . . . . . . . . . . . . . . . . . . 5
  53.       2.7.4 T-Mail mailer . . . . . . . . . . . . . . . . . . . . . . . . . 6
  54.       2.7.5 SRIF capable mailer . . . . . . . . . . . . . . . . . . . . . . 6
  55.     2.8 The Setup Program (JFREQCFG.COM / JFRQCFGP.EXE) . . . . . . . . . . 6
  56.       2.8.1 Global Options  . . . . . . . . . . . . . . . . . . . . . . . . 6
  57.       2.8.2 Time Settings:  . . . . . . . . . . . . . . . . . . . . . . . . 7
  58.       2.8.3 Limits  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
  59.       2.8.4 Mail Addresses  . . . . . . . . . . . . . . . . . . . . . . . . 8
  60.       2.8.5 Template Editor . . . . . . . . . . . . . . . . . . . . . . . . 8
  61.  
  62.   3. Other data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
  63.     3.1 JFReq Command Line Parameters . . . . . . . . . . . . . . . . . . . 9
  64.     3.2 Tokens used in templates  . . . . . . . . . . . . . . . . . . . . . 9
  65.     3.3 File Format for File & Directory listings and Alias file  . . . .  11
  66.       3.3.1 file & directory listing: . . . . . . . . . . . . . . . . . .  11
  67.       3.3.2 ALIAS listing:  . . . . . . . . . . . . . . . . . . . . . . .  11
  68.       3.3.3 On-line Programs and the alias file list  . . . . . . . . . .  11
  69.     3.4 The nodelist compiler . . . . . . . . . . . . . . . . . . . . . .  12
  70.     3.5 The custom file index compiler  . . . . . . . . . . . . . . . . .  13
  71.     3.6 Remote Access file index Speed-up . . . . . . . . . . . . . . . .  13
  72.     3.7 VIP Systems . . . . . . . . . . . . . . . . . . . . . . . . . . .  13
  73.     3.8 Statistical Reports . . . . . . . . . . . . . . . . . . . . . . .  14
  74.     3.9 Special Requests with Attached Messages . . . . . . . . . . . . .  15
  75.     3.10 TIC support  . . . . . . . . . . . . . . . . . . . . . . . . . .  15
  76.     3.11 Editor Commands  . . . . . . . . . . . . . . . . . . . . . . . .  15
  77.     3.12 Local Testing  . . . . . . . . . . . . . . . . . . . . . . . . .  16
  78.     3.13 Credits  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  16
  79.     3.14 How to contact the author  . . . . . . . . . . . . . . . . . . .  17
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.                                        i
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.                                    Chapter 1
  94.  
  95.                                  Introduction
  96.  
  97.  
  98.  
  99.  
  100.  
  101.   1.1 What is a File Request Processor?
  102.  
  103.   Once upon a time, fidonet mailers searched a huge list of directories  each
  104.   time  another  system requested a file, wasting a lot of time in sequential
  105.   searches.  Now, from  FrontDoor  2.1x,  Intermail  2.27  and  MainDoor  and
  106.   MainDoor/2,  you  can  execute  an  external  utility  to fast locate those
  107.   requested files and  generate  a  personalised  response  message  for  the
  108.   asking system.
  109.  
  110.   JFReq  uses  the existing file indexes of the BBS package (Maximus & Remote
  111.   Access are currently supported).  This use of the automated index  of  your
  112.   BBS  makes  it  possible  to run this program with almost no maintenance at
  113.   all.
  114.  
  115.  
  116.   1.2 Features of JFReq 1.03
  117.  
  118.   * Native versions for DOS and OS/2
  119.   * Multiline support
  120.   * Easy to use configuration program
  121.   * Mailers supported:   FrontDoor (2.1x or better), MainDoor, InterMail
  122.     (2.27 or better), T-Mail or compatible mailers. Also supports SRIF
  123.   * BBS File Bases supported:  Maximus (2.x, 3.x) and Remote Access (2.x)
  124.     (supported directly), and any system based on the FILES.BBS
  125.     structure.
  126.   * Directory listing and Alias file (with or without password)
  127.   * You can limit by day and/or session: Files, Kbytes to transmit, and
  128.     session lenght in minutes.
  129.   * Five types of session: Secure(with password), Listed & Unlisted
  130.     Systems, VIP Systems (fully customizable) and a Happy Hour period,
  131.     defining file lists and limits for each type of session separately.
  132.   * You can search for the existence of a specific node in a custom
  133.     nodelist index.
  134.   * Use of an equivalent user level for BBS File Base access
  135.   * Twit systems control definition, checking every piece of information
  136.     from the remote system
  137.   * Request Report and error messages are totally customizable, and
  138.     templates are selected automatically depending on the remote system's
  139.     address
  140.   * Additional messages are added when the remote system requests a
  141.     special file
  142.   * JFReq can send TIC files describing each of the files
  143.  
  144.  
  145.                                        1
  146.  
  147.   Chapter 1. Introduction                                                   2
  148.  
  149.  
  150.   * On-line program execution for registrations or remote processes
  151.   * File Password & Download Counter Support in Remote Access
  152.   * Automatic Download Counter Support for Maximus and FILES.BBS index.
  153.   * Free file/area support in all modes
  154.   * File Buffering for CD-ROMs and other critical drives
  155.   * Statistical reports as messages.
  156.  
  157.  
  158.   1.3 Files in the distribution package
  159.  
  160.   100to101.COM    Configuration upgrade program to 1.01
  161.   101to102.COM    Configuration upgrade program to 1.02
  162.   102to103.COM    Configuration upgrade program to 1.03
  163.   STCONV.COM      Statistics upgrade program from 1.00 & 1.01. DOS version
  164.   STCONVP.EXE     Statistics upgrade program from 1.00 & 1.01. OS/2 version
  165.   JFREQ.DOC       JFReq users' manual. English version
  166.   JFREQ.ESP       JFReq users' manual. Spanish version
  167.   JFREQP.EXE      JFReq main executable. OS/2 version
  168.   JFRQCFGP.EXE    JFReq configuration utility. OS/2
  169.   JFREQ.EXE       JFReq main executable. DOS version
  170.   JFREQCFG.COM    JFReq configuration utility. DOS
  171.   JFNCP.EXE       Nodelist compiler. OS/2 version
  172.   JFNC.COM        Nodelist compiler. DOS version
  173.   JFNC.CTL        Nodelist control file for JFNC
  174.   JFFCP.EXE       Secondary file index generator. OS/2
  175.   JFFC.COM        Secondary file index generator. DOS
  176.   JFFC.CTL        Secondary file index control file
  177.   JFSTATP.EXE     Statistical Reports generator. OS/2
  178.   JFSTAT.COM      Statistical Reports generator. DOS
  179.   LDATP.EXE       JFREQ.DAT lister (OS/2)
  180.   LDAT.COM        JFREQ.DAT lister (DOS)
  181.   DEFAULT.FRQ     Default response template
  182.   *.FRQ           Sample response templates
  183.   FNAMES.DAT      Special requests control file
  184.   REGISTER.TXT    Registration info, English version
  185.   REGISTRO.TXT    Registration info, Spanish version
  186.   UADDRESS.DAT    Twit systems (by address) control file
  187.   UMAILERS.DAT    Twit systems (by string) control file
  188.   JFREQ.CFG       Configuration file
  189.   JFREQ.DAT       Data file (node information)
  190.   JFNC.NDX        Nodelist index
  191.   JFFILES.IDX     Custom File Index
  192.   JFAREA.DAT      Custom Area Index
  193.   JFREQ.VIP       VIP Systems specifications file
  194.   RAFILES.IDX     RA speed-up index for JFREQ
  195.   JFRAFC.COM      RA File Area Compiler for JFREQ (DOS)
  196.   JFRAFCP.EXE     RA File Area Compiler for JFREQ (OS/2)
  197.   ??#???.IDX      Daily statistics file (index)
  198.   ??#???.DAT      Daily statistics file (data)
  199.   ACUM.IDX        Main statistics index
  200.   ACUM_F.DAT      File statistics
  201.   ACUM_N.DAT      Node statistics
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.                                    Chapter 2
  209.  
  210.                                      Setup
  211.  
  212.  
  213.  
  214.  
  215.  
  216.   2.1 UPGRADING from version 1.00
  217.  
  218.   There is no direct upgrade from version  1.00  to  1.03.   You  should  run
  219.   100to101.com  to  upgrade  JFREQ.CFG to 1.01.  Delete the file JFREQ.COM if
  220.   using DOS version.  Then read and follow  next  sections  to  complete  the
  221.   process.
  222.  
  223.  
  224.   2.2 UPGRADING from version 1.01
  225.  
  226.   a)  Run the utility called 101to102.com to update the file JFREQ.CFG to the
  227.   1.02 version.
  228.  
  229.   b) Run the utility called STCONV.com (STCONVP.exe in OS/2) to upgrade  your
  230.   statistics files to the new format.
  231.  
  232.   c) Then read and follow next sections to complete the process.
  233.  
  234.  
  235.   2.3 UPGRADING from version 1.02
  236.  
  237.   a)  Unpack  your  1.03 archive in the JFREQ directory, being careful not to
  238.   overwrite your 1.02 configuration files.
  239.  
  240.   b) Run the utility called 102to103.com to update the file JFREQ.CFG to  the
  241.   1.03 version.
  242.  
  243.   c)  If you are using a fast index for Remote Access, run JFRAFC (JFRAFCP in
  244.   OS/2) to update that index.
  245.  
  246.   d) If you maintain a custom index  run  JFFC.com  (JFFCP.exe  in  OS/2)  to
  247.   update the custom index.
  248.  
  249.   e) Run the configuration utility to check everything is fine.
  250.  
  251.  
  252.   2.4 General Installation Notes
  253.  
  254.   JFReq  runs  on  a  286 or better processor.  SHARE or equivalent should be
  255.   installed if under DOS.  Set an entry in your PATH pointing  to  the  JFReq
  256.   main directory.
  257.  
  258.  
  259.  
  260.                                        3
  261.  
  262.   Chapter 2. Setup                                                          4
  263.  
  264.  
  265.   Use  the directory listings just for those files and / or directories which
  266.   are NOT in your BBS index.  This search  is  quite  slow  compared  to  the
  267.   indexes, so use it only when necessary.
  268.  
  269.   The  custom index is intended for aditional file Doors or systems running a
  270.   BBS software other than RA or  Max.   For  those  later  systems  to  work.
  271.   leave  blank  the  'BBS  Path' field and select Remote Acces as 'BBS Type'.
  272.   In case you use RA or Max, this custom index is also checked if active.
  273.  
  274.   In a single request session, JFReq can search an ALIAS  file,  a  directory
  275.   listing,  a BBS index and a custom index.  Please try to make the search as
  276.   fast as possible, avoiding searching the same files more than once.
  277.  
  278.  
  279.   2.5 Multiline systems
  280.  
  281.   Nothing  has  to  be  done  in  a  multiline  system,  except  having   the
  282.   environment  variables  set  correctly.   JFReq  keeps  a LOG file for each
  283.   session (called JFREQ@.LOG, being  @  the  value  of  the  TASK  variable),
  284.   opening  it  with  exclusive  access  to prevent configuration errors.  All
  285.   other files are opened in shared mode.
  286.  
  287.  
  288.   2.6 Environment Variables
  289.  
  290.   TASK     Current task number. Needed for the support & temporary
  291.            files when you run a multiline system
  292.  
  293.   JFREQ    Points to the main JFReq directory. Needed when you
  294.            execute the program from a different directory.
  295.  
  296.   examples:
  297.   SET TASK=1
  298.   SET JFREQ=C:\JFREQ
  299.  
  300.   If you use MainDoor, make sure your MD environment variable is set.
  301.  
  302.  
  303.   2.7 Mailer Setup
  304.  
  305.   IMPORTANT: Do not use very large paths in your  Mailer  configuration,  for
  306.   Inbound  &  PKT  directories, since the limitation of 128 characters in the
  307.   command line (due to the operating system  limitations)  might  cause  some
  308.   trouble in the execution.
  309.  
  310.   IMPORTANT:  Please  write  the  parameters  in  the command line exactly as
  311.   shown here, except for the executable name (JFREQ for DOS,  JFREQP.EXE  for
  312.   OS/2), and its execution path (if needed).
  313.  
  314.   Chapter 2. Setup                                                          5
  315.  
  316.  
  317.   2.7.1 MainDoor & MainDoor/2
  318.  
  319.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│ File Request         │░░░░░░░░░░░░░░░
  320.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│ Swap┌─── File Request ────┐░░░░░░░░░░
  321.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│ Ento│ Ficheros            │░░░░░░░░░░
  322.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░└─────│ Límites             │░░░░░░░░░░
  323.   ░░░░░░░░░░░░░░░░░░ Copyright (c) 19│ Procesador          │ppa. ░░░░░
  324.   ┌──────────────────────────────── File Req - FRQP ──────────────────
  325.   │ Program  jfreq /MD =F =R =T =X =B =H =D =W
  326.   │ Activo   Si
  327.   │ Swapping Si
  328.   └───────────────────────────────────────────────────────────────────
  329.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  330.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  331.  
  332.   Note:  in  some  versions  of MainDoor, the =W switch is not yet supported.
  333.   This won't affect the request, since this is an optional parameter.
  334.  
  335.   2.7.2 FrontDoor 2.1x & 2.2x
  336.  
  337.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ ╔═══════════════════╗▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  338.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ ║                   ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  339.   ▒╔═══════════════════════════════════════════════ Request processor
  340.   ▒║
  341.   ▒║ Program  jfreq /FD =F =R =T =X =B =H =D =W░░░░░░░░░░░░░░░░░░░░░░░
  342.   ▒║ Enabled  Yes
  343.   ▒║ Swapping Yes
  344.   ▒║
  345.   ▒╚══════════════════════════════════════════════════════════════════
  346.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ Swapping         ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  347.   ▒▒▒▒▒▒▒▒ Copyright ║ Protection       ║mrighausen; All rights reserv
  348.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ Fax              ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  349.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒╚══════════════════╝▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  350.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  351.  
  352.   2.7.3 Intermail 2.27
  353.  
  354.   ╔════════════════════════════════════════════════════ File requests
  355.   ║
  356.   ║ Mode      Anyone can request
  357.   ║ List      C:\IM\SYSTEM\OKREQDIR.LST
  358.   ║ Alias
  359.   ║ Message
  360.   ║ Max match 0
  361.   ║ Max time  0
  362.   ║ Max size  0
  363.   ║ Min speed 300
  364.   ║ Limited   No
  365.   ║ Start     00:00
  366.   ║ End       00:00
  367.   ║ Days      -------A
  368.   ║ External  JFREQ /IM %A %F %X %B %M %D %O░░░░░░░░░░░░░░░░░░░░░░░░░░
  369.   ║
  370.   ╚═══════════════════════════════════════════════════════════════════
  371.  
  372.   Chapter 2. Setup                                                          6
  373.  
  374.  
  375.   2.7.4 T-Mail mailer
  376.  
  377.   You must add a line very similar to the following to your T-Mail.Cfg file:
  378.  
  379.    Process Freq JFREQ /TM <busy.t-m> *F <packets_dir>\T-$$-*T\RESPONSE.FRQ *H
  380.  
  381.   being:
  382.   <busy.t-m>      the path and filename of the Busy Flag file, as defined
  383.                   in T-Mail.Ctl
  384.   <packets_dir>   the directory for storing T-Mail packets, as defined in
  385.                   T-Mail.Ctl
  386.  
  387.   2.7.5 SRIF capable mailer
  388.  
  389.   You just have to call JFReq with  the  parameter  /SRIF,  followed  by  the
  390.   information file created by your mailer:
  391.  
  392.    JFREQ /SRIF <srif info file>
  393.  
  394.   Take  a  look  at  your  mailer's documentation and sustitute the bracketed
  395.   sentence  for  its  corresponding  macro.   If  your  version  of  MainDoor
  396.   supports SRIF, then call JFReq as above but using /MDS instead of /SRIF.
  397.  
  398.  
  399.   2.8 The Setup Program (JFREQCFG.COM / JFRQCFGP.EXE)
  400.  
  401.   The  Setup  Program is very easy to use and each option is explained at the
  402.   bottom of the screen when you are on it.  The options  marked  with  a  <+>
  403.   sign  are  available  only to registered users.  If you are an unregistered
  404.   user, please read  the  file  REGISTER.TXT  to  know  how  to  obtain  your
  405.   registration key.
  406.  
  407.   2.8.1 Global Options
  408.  
  409.   Allows you to change the values for the common options to all sessions:
  410.  
  411.               BBS Type - currently Maximus and Remote access supported
  412.               BBS Path - main BBS directory
  413.       Use Custom Index - whether to use a secondary index created by
  414.                          compiling FILES.BBS files. Use this option to
  415.                          add support for CD-ROM doors not included in the
  416.                          BBS index, or to use JFReq with another BBS
  417.                          package (in this case, use the Remote Access
  418.                          BBS type and leave blank the BBS Path field).
  419.      Download Counters - Type of download counter support. If you use
  420.                          Remote Access, set to any of the types. If you
  421.                          are using the custom index, choose the one you
  422.                          use in your FILES.BBS files. The download counter
  423.                          MUST exist for JFReq to update it.
  424.         Min. Baud Rate - minimum baud speed allowed
  425.          PKT Directory - directory for temporary and outbound packets
  426.                          (normally the outbound directory or a RAM disc)
  427.          LOG Directory - directory for LOG files
  428.       Special Requests - edit the file that holds the filenames to attach
  429.                          additional messages. The format is just <NAME>
  430.  
  431.   Chapter 2. Setup                                                          7
  432.  
  433.  
  434.                          <full path msg file>. Messages can contain any of
  435.                          the available tokens. If you wish to send an
  436.                          additional message allways, use a point (.) as
  437.                          filename.
  438.        Nodelist Lookup - enables / disables nodelist lookup in the custom
  439.                          nodelist index
  440.        Nodelist Files  - edits the list of nodelists to process when
  441.                          executing JFNC/JFNCP, the nodelist compiler
  442.    Allow Outbound Req. - if you allow file requests from systems you are
  443.                          calling
  444.        Buffered Drives - files from those discs will be copied to a TEMP
  445.                          directory and deleted automatically after the
  446.                          session
  447.         Buffering Path - temporary directory used to hold buffered files
  448.        Keep Statistics - keep track of the data for later statistical
  449.                          reports. This option also controls Crash FREQ
  450.                          detection.
  451.       Expand Wildcards - whether to send more than one file per request,
  452.                          when it contains a wildcard character
  453.            CC to Sysop - If you want to receive a copy (as Netmail) of the
  454.                          message(s) sent to each calling system.
  455.      Inbound Directory - Where to put the Carbon Copy .PKTs in order to be
  456.                          processed by your mail processor.
  457.  
  458.   2.8.2 Time Settings:
  459.  
  460.             Start Time - global startup time for file requests
  461.               End Time - global ending time for file requests
  462.         Happy H. Start - startup time of the Happy Hour period
  463.           Happy H. End - ending time of the Happy Hour period
  464.  
  465.   2.8.3 Limits
  466.  
  467.   Used to fix the limitations for each set of sessions:
  468.  
  469.      Listed / Unsecure - sessions with listed systems without password
  470.               Unlisted - sessions with unlisted systems and without a
  471.                          session password
  472.             Passworded - password protected sessions. it does not mind
  473.                          whether the system is listed or not
  474.             Happy Hour - unsecure sessions (systems without a session
  475.                          password) within the Happy Hour period
  476.            VIP Systems - edit the specifications list for VIP Systems.
  477.                          Consult the section VIP Systems to know about the
  478.                          file format.
  479.       Unwanted Systems - two files containing strings to match with the
  480.                          remote system's information. all systems with
  481.                          matching strings will be considered twit systems
  482.                          and they will be sent the BadTemplate portion of
  483.                          the corresponding template
  484.  
  485.   The options for each of these are the following:
  486.  
  487.        Alias List File - edits a file containing alias file names and
  488.                          their equivalences. its format is discussed later
  489.  
  490.   Chapter 2. Setup                                                          8
  491.  
  492.  
  493.                          in this document
  494.         Directory List - edits a file containing a list of files and
  495.                          directories (with or without a password), to
  496.                          protect special directories or files that are not
  497.                          in the BBS filebase. its format is discussed
  498.                          later in this document
  499.   Level for BBS Access - BBS user level equivalent to the session type,
  500.                          used to check the access to BBS file areas
  501.           Maximum Time - maximum time allowed in a single session,
  502.                          calculed from the connection speed and the file
  503.                          sizes
  504.           Maximum Size - maximum accumulated file size allowed in a session
  505.          Maximum Files - maximum number of files to be transmitted in a
  506.                          single session
  507.       Max Time per Day - maximum time allowed per day
  508.       Max Size per Day - maximum size allowed per day
  509.      Max Files per Day - maximum number of files allowed per day
  510.  
  511.           NOTES:
  512.           a) to disable a limit, enter a '0' value
  513.           b) if you leave blank the alias or directory list file, you will
  514.              disable that file checking in those sessions
  515.  
  516.   2.8.4 Mail Addresses
  517.  
  518.   Definition  of  the local system main address and up to seventeen secondary
  519.   mail addresses(AKAs)
  520.  
  521.   2.8.5 Template Editor
  522.  
  523.   Allows you to edit each of the templates from the setup program,  selecting
  524.   first the file and then optionally editing:
  525.  
  526.         Error Messages - edits each of the possible error responses
  527.               Template - edits the message to send in all allowed sessions
  528.           Bad Template - edits the message to send in case the system is
  529.                          found to be a 'twit' one
  530.  
  531.   Please  read  the section 'editor commands' to know how to use the internal
  532.   editor
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.                                    Chapter 3
  540.  
  541.                                   Other data
  542.  
  543.  
  544.  
  545.  
  546.  
  547.   3.1 JFReq Command Line Parameters
  548.  
  549.   Here is a description of the parameters passed in the command line.   These
  550.   parameters  are  the  mailer's,  not  JFREQ's.   JFReq  reads  all  of them
  551.   directly, to improve speed.  Please enter the  corresponding  command  line
  552.   exactly as stated for each operation mode
  553.  
  554.   Operation Mode Selection:
  555.     /MD     MainDoor Mode
  556.     /FD     FrontDoor Mode
  557.     /IM     InterMail Mode
  558.     /TM     T-Mail Mode
  559.     /SRIF   SRIF Mode
  560.     /MDS    MainDoor in SRIF Mode
  561.   Mailer macros for FD/MD Mode
  562.     =F      Remote System information file
  563.     =R      File containing requested files
  564.     =T      File to create containing files to be sent
  565.     =X      SECURE/UNSECURE
  566.     =B      Session speed in BPS
  567.     =H      Minutes until next event not allowing FREQs
  568.     =D      INBOUND/OUTBOUND (call direction)
  569.     =W      LISTED/UNLISTED
  570.   Mailer macros for Intermail mode:
  571.     %A      Remote system's mail address
  572.     %F      File containing requested files
  573.     %X      SECURE/UNSECURE/UNLISTED
  574.     %B      Session Speed in BPS
  575.     %M      Minutes until next event not allowing file requests
  576.     %D      INBOUND/OUTBOUND (call direction)
  577.     %O      Remote System's Sysop Name
  578.  
  579.  
  580.   3.2 Tokens used in templates
  581.  
  582.   By  using  response  templates,  you can completely customize the resulting
  583.   message.  Those files have the .FRQ extension,  and  they  contain  in  its
  584.   main file name the clue to know what systems they will be sent to:
  585.  
  586.          2#343.FRQ    ->  will be sent to all systems in zone 2, net 343
  587.          2#34@.FRQ    ->  will be sent to all systems in zone 2, and a net
  588.                           number starting with 34 (341, 3421,...) that do
  589.  
  590.  
  591.                                        9
  592.  
  593.   Chapter 3. Other data                                                    10
  594.  
  595.  
  596.                           not have another specific template.
  597.          2.FRQ        ->  will be sent to all systems in zone 2 that do
  598.                           not have another specific template
  599.          DEFAULT.FRQ  ->  will be sent to all systems without a defined
  600.                           template
  601.                           This file MUST exist.
  602.          MYPOINTS.FRQ ->  if exists, it will be sent to OUR points
  603.  
  604.   If  you create any files that match the names of the .FRQ files, but with a
  605.   .FRP extension, they will be used with systems that are Points.  Thus,  you
  606.   can have one template for Nodes, and another one for points.
  607.  
  608.   To  create  a new template, just copy an existing template to the file name
  609.   corresponding to the set of addresses to be sent to.
  610.  
  611.   All those files can be edited with any ASCII editor, but  it  is  safer  to
  612.   use  the  internal  editor,  since  you  can edit all the data separatedly.
  613.   Please follow the comments inside the files.
  614.  
  615.           NOTES:
  616.           a) The automatic paragraph justification eliminates any extra
  617.              blanks, and sets a right margin of 75. All lines are left
  618.              justified.
  619.           b) Please do not forget to use the same Capitalization listed
  620.              here for any of the tokens
  621.  
  622.   Token                   Value/Action
  623.   ---------------------------------------------------------------------
  624.   @@BegJust       Indicates the beginning of a justified paragraph
  625.   @@EndJust       Indicates the end of a justified paragraph
  626.   @@FileDesc      Here the listing of files and descriptions will be inserted
  627.   @@FrqSyst       Remote system's name
  628.   @@FrqName       Full name of the remote system's sysop
  629.   @@FrqAddr       Mail Address of the remote system
  630.   @@FrqFrom       Remote system's 'From' field
  631.   @@FrqPhon       Remote system's telephone number
  632.   @@FrqSPWD       Session Password used (blank if none)
  633.   @@FrqSerN       Remote system's Mailer Serial Number
  634.   @@SesType       Current Session Type (secure/unsecure/unlisted/happy hour)
  635.   @@PrgName       Current program version
  636.   @@RegName       Local user's name inside the key file
  637.   @@AKMatch       Local mail address matching remote's
  638.   @@RegAKA<#>     Local mail addresses. substitute <#> for the AKA number
  639.   @@MinBaud       Minimum baud rate allowed
  640.   @@BegTime       Global startup time for allowing file requests
  641.   @@EndTime       Global ending time for allowing file requests
  642.   @@BegHapp       Happy Hour startup time
  643.   @@EndHapp       Happy Hour ending time
  644.   @@OkFiles       Number of located files (not free) in this session
  645.   @@TKbytes       Total Ks in located files (not free) in this session
  646.   @@TFreeKB       Total Ks in located free files in this session
  647.   @@OkFFree       Number of located free files in this session
  648.   @@CumCall       Accumulated request calls of the remote system
  649.   @@CumFile       Accumulated number of files requested by the remote system
  650.   @@CumSize       Accumulated number of KBytes requested by remote
  651.  
  652.   Chapter 3. Other data                                                    11
  653.  
  654.  
  655.   @@CumTime       Accumulated minutes by remote
  656.   @@DayFile       Total files requested today by the remote system
  657.   @@DaySize       Ks. requested today by the remote system
  658.   @@DayTime       Minutes spent today by the remote system
  659.   @@MaxFile       Maximum files allowed in this session
  660.   @@MaxSize       Maximum size in Ks allowed in this session
  661.   @@MaxTime       Maximum time in minutes allowed in this session
  662.   @@Ma<#>File     Maximum number of files allowed in this type of session
  663.   @@Ma<#>Size     Maximum number of Ks allowed in this session type
  664.   @@Ma<#>Time     Maximum number of minutes allowed in this session type
  665.   @@Da<#>File     Maximum files per day in this session type
  666.   @@Da<#>Size     Maximum Ks per day in this session type
  667.   @@Da<#>Time     Maximun minutes per day in this session type
  668.  
  669.   Please substitute <#> for:
  670.           L - listed unsecure sessions
  671.           U - unlisted unsecure sessions
  672.           H - happy hour sessions
  673.           P - password protected sessions
  674.           A - active session type
  675.  
  676.  
  677.   3.3 File Format for File & Directory listings and Alias file
  678.  
  679.   These files may be diferent for each type of session and  must  contain  an
  680.   entry per line, with no blank lines and following this format:
  681.  
  682.   3.3.1 file & directory listing:
  683.  
  684.     to represent files:
  685.   <drive>:\<path>\<name>.<ext> [!<password>]
  686.     to represent directories:
  687.   <drive>:\<path> [!<password>]
  688.     example:
  689.   C:\FILES\SECRET.* !secure
  690.  
  691.   3.3.2 ALIAS listing:
  692.  
  693.   <alias>[$] [!<passwd>] <drive>:\<path>\<name>.<ext> [<drive>:\<path>\...]
  694.     examples:
  695.     THE_BETA !secure C:\FILES\SECRET.* C:\FILES\NOTES.ZIP
  696.     FILES$   C:\FILES\FILELIST.ZIP
  697.  
  698.   Aliases  ending  with  a dollar sign ('$') are considered free files.  This
  699.   dollar sign is not considered a part of  the  alias  name.   (passwords  in
  700.   both files are optional)
  701.  
  702.   3.3.3 On-line Programs and the alias file list
  703.  
  704.   If  using OS/2, please don't miss the special section for OS/2 USERS below.
  705.   Please check in DOS systems  memory  limitations  and  use  utilities  that
  706.   require very few memory to run.
  707.  
  708.   In  order  to  execute  an  online  program  the user must request, just as
  709.   another file:
  710.  
  711.   Chapter 3. Other data                                                    12
  712.  
  713.  
  714.    %PRG=<program_alias> <program_parameters>
  715.  
  716.   Being <program_alias> the magic name associated with the online program.
  717.   This magic should not be longer than 12 chars and be located in the
  718.   corresponding Alias file, ending with a '%' sign, to indicate its
  719.   nature, with this format:
  720.  
  721.    <on-line_magic>% <type> <response_file> <program_command_line>
  722.    [<parameters>]
  723.  
  724.    being:
  725.  
  726.    <on-line_magic>     the magic name
  727.    <type>              any if the following:
  728.                       PKT  --> the response file is a standard PKT to be
  729.                                sent directly to the remote user, and will
  730.                                be deleted by the mailer after it is sent.
  731.                       ATT  --> the response file is to be attached
  732.                                directly, and will be deleted by the mailer
  733.                                after it is sent.
  734.                       MSG  --> the response file is a plain ASCII file,
  735.                                which has to be converted and sent as a
  736.                                message packet by JFReq.
  737.   <response_file>     the file result of the on-line program execution
  738.   <prg_command_line>  the command line of the on-line program to be
  739.                       executed.
  740.  
  741.   <parameters>        (optional) extra parameters added to the %PRG
  742.                       request will be added before the user-specified
  743.                       parametters and will be passed to the on-line
  744.                       program.
  745.  
  746.   OS/2 USERS: If you have trouble running your on-line program  under  JFReqP
  747.   (low  memory  or  system  errors), or you want to use a .CMD file, you must
  748.   use HSTART (included in this package) with the /C and /WAIT  parameters  to
  749.   open a new OS/2 session.  An example of its use would be:
  750.  
  751.           LISTADOR% MSG c:\pkt\fichero.res HSTART /C /WAIT listador.cmd
  752.  
  753.  
  754.   3.4 The nodelist compiler
  755.  
  756.   The  executable file JFNC.COM (JFNCP.EXE for OS/2) builds up an index based
  757.   on  the  definitions  in  the  file  JFNC.CTL.   With  the  resulting  file
  758.   (JFNC.NDX),  JFReq  will  know inmediately wether a system is listed in any
  759.   of the nodelists.
  760.  
  761.   It is recomended that you use this function (Nodelist Lookup) only if  your
  762.   mailer  does  not  provide  this  information, since this nodelist checking
  763.   adds some time to the global process.
  764.  
  765.   Remember to use the nodelist compiler each time  you  modify  any  of  your
  766.   nodelists.
  767.  
  768.   Chapter 3. Other data                                                    13
  769.  
  770.  
  771.   The  JFNC.CTL  file  is  fully commented inside, so you should not have any
  772.   difficulty with that.
  773.  
  774.  
  775.   3.5 The custom file index compiler
  776.  
  777.   In order to  use  the  secondary  index,  you  must  build  an  ASCII  file
  778.   (JFFC.CTL) using your favorite editor following this line format:
  779.  
  780.   [!<password>] [#[$]<level>] <down. path> <files.bbs path> <desc. column>
  781.  
  782.   [!<password>] (optional) password for all files in this area
  783.  
  784.   [#[$]<user  level>]  (optional) equivalent user level for this file area in
  785.   numerical format.  if you are using the Maximus mode, use this table:
  786.  
  787.            0 - Disgrace         If you use the Remote Access mode, just
  788.            1 - Limited          use the verbatim you would use in RACONFIG
  789.            2 - Normal           or JFREQCFG.
  790.            3 - Worthy
  791.            4 - Privil
  792.            5 - Favoured
  793.            6 - Extra
  794.            7 - Clerk
  795.            8 - AsstSysop
  796.            9 - SysOp
  797.  
  798.   NOTE: File areas with a  dollar  sign  ('$')  before  the  user  level  are
  799.   considered Free by JFReq.
  800.  
  801.   To update this index, execute JFFC(P) when necessary.
  802.  
  803.  
  804.   3.6 Remote Access file index Speed-up
  805.  
  806.   You  can  use  an  special  index  with  RA to decrease response times when
  807.   performing file searches.  This index must be updated al least once  a  day
  808.   if  you  change  any information in your BBS file index files.  To use this
  809.   special index, just run the utility called JFRAFC.EXE to obtain  the  index
  810.   file RAFILES.IDX in your JFREQ directory.
  811.  
  812.   The  use  of  this  index is automatic, so you have not to touch a thing in
  813.   your JFREQ configuration.
  814.  
  815.  
  816.   3.7 VIP Systems
  817.  
  818.   JFREQ allows you to define specific  limitations  with  your  VIP  systems,
  819.   based  on  the  main  address  of the calling system.  The specificatios to
  820.   allow this are in the file JFREQ.VIP:
  821.  
  822.   Syst. Address BBS Lev. MaxTime MaxSize MaxFile DayTime DaySize DayFile
  823.   ------------- -------- ------- ------- ------- ------- ------- -------
  824.   @2:343/116.*      300      60     5000      25      0       0       0
  825.  
  826.   Chapter 3. Other data                                                    14
  827.  
  828.  
  829.   2:343/129.0       300      60     5000      25      0       0       0
  830.   2:343/117.0       300      60     5000      25      0       0       0
  831.  
  832.   '@' before an address means that the session must be 'secure' for this  Vip
  833.   level to apply
  834.  
  835.   Valid BBS user levels:
  836.   ----------------------
  837.   RA mode:
  838.    use the same figures you use in  JFREQCFG
  839.   Maximus mode:
  840.    0 - Disgrace
  841.    1 - Limited
  842.    2 - Normal
  843.    3 - Worthy
  844.    4 - Privil
  845.    5 - Favoured
  846.    6 - Extra
  847.    7 - Clerk
  848.    8 - AsstSysop
  849.    9 - SysOp
  850.  
  851.   Please  use FULL 4D addresses as shown above.  Wildcards are allowed at any
  852.   place of the address.
  853.  
  854.   0 in any field (except BBS level) means 'no limit'
  855.  
  856.  
  857.   3.8 Statistical Reports
  858.  
  859.   JFSTAT(P)  is  the  program  you  must  execute  in  order  to  obtain   an
  860.   statistical  report  of  your  system.   These  statistics are based on all
  861.   tasks of the system.
  862.  
  863.   The syntax of this program can be:
  864.  
  865.   a) report as a PKT file, to netmail or a message area:
  866.  
  867.    JFSTAT(P) /PKT <to> <area> <inbound path> [days to report] [days to purge]
  868.  
  869.   <to> stands for the name to address  the  message,  using  underscores  for
  870.   spaces (e.g.  Joe_Sysop).
  871.  
  872.   <area>  is  NETMAIL  for netmail message or the tag of the area you want to
  873.   have the report delivered.
  874.  
  875.   <inbound path> is the path you use for receiving the inbound mail  packets.
  876.   To  be  compatible  with any message base, the output is done to a standard
  877.   PKT file, to be processed later on by your mail processor.
  878.  
  879.   b) report to screen:
  880.  
  881.    JFSTAT [days to report] [days to purge]
  882.  
  883.   Chapter 3. Other data                                                    15
  884.  
  885.  
  886.   [days to report] are the number of days you  want  to  be  reported  about.
  887.   '0' or nothing means reporting everything available.
  888.  
  889.   [days  to  purge]  after reporting, any data before [days] will be deleted.
  890.   Eg.  if you specify 4, any data older than four days  from  today  will  be
  891.   deleted.   If  you  enter  0,  all data will be deleted.  This process only
  892.   affects the statistical  data.   Node  information  and  Logs  will  remain
  893.   intact.  If you do not provide a number, nothing will be deleted.
  894.  
  895.   you  can  execute  JFSTAT  with  no arguments, which will give you a global
  896.   statistical report (to screen) of all days kept.
  897.  
  898.  
  899.   3.9 Special Requests with Attached Messages
  900.  
  901.   JFReq allows you to add specific messages to the mail packet if the  remote
  902.   system  requests  a  specific  file.   Thos  messages  can  use  all tokens
  903.   available.  To activate this option, simply edit the file  FNAMES.DAT  from
  904.   the  configuration  program,  by  using  the  'Special  Requests' option in
  905.   Global options.  In this file, you must specify a full filename  (wildcards
  906.   allowed)  to match, along with a file name corresponding to the message you
  907.   want to send to all systems requesting those files.  By  instance,  if  you
  908.   define the following line in FNAMES.DAT:
  909.  
  910.       *.JPG    c:\jfreq\gifjpg.msg
  911.  
  912.   The  file  named  gifjpg.msg  will  be  added to the response packet (after
  913.   converting any tokens included), to all systems  requesting  files  with  a
  914.   JPG extension.
  915.  
  916.  
  917.   3.10 TIC support
  918.  
  919.   JFReq  can send a .TIC file along with each requested file.  This .TIC file
  920.   is fully featured, so it should  work  with  any  fileecho  processor.   To
  921.   activate  this feature, the requesting system should add to its request, as
  922.   if they were two more files:
  923.  
  924.    %TIC=<area>
  925.    %PWD=<password>
  926.  
  927.   Being <area> the fileecho to  import  the  file,  and  <password>  the  one
  928.   defined in remote's file processor for our system.
  929.  
  930.  
  931.   3.11 Editor Commands
  932.  
  933.   The  JFReq  Setup  program  includes a simple editor to help you in editing
  934.   the configuration files.  Apart form  the  cursors  and  other  well  known
  935.   editing keys, those are other keys you can use inside the editor:
  936.  
  937.   Ctrl+rig. arrow - places the cursor in the beginning of the next word
  938.   Ctrl+left arrow - places the cursor in the beginning of the previous word
  939.          Ctrl+end - deletes from the cursor to the end of line
  940.         Ctrl+home - deletes from the cursor to the beginning of the line
  941.  
  942.   Chapter 3. Other data                                                    16
  943.  
  944.  
  945.    Ctrl+backspace - deletes a entire line (you can undelete it with Alt+R)
  946.         Ctrl+PgDn - places the cursor at the end of the document
  947.         Ctrl+PgUp - places the cursor at the beginning of the document
  948.             Alt+S - copies the current line in memory
  949.             Alt+R - restores the latest copied or deleted line
  950.             Alt+X - ends the editing, saving the file
  951.  
  952.  
  953.   3.12 Local Testing
  954.  
  955.   If  you  want  to  test your JFReq installation locally, here's a procedure
  956.   you can follow:
  957.  
  958.   a) Create a plain ASCII file with similar contents to this one.  This  file
  959.   stores the information of the virtual remote caller:
  960.  
  961.   ----> begin srif.nfo <----
  962.   Sysop           Juan Martin Perez
  963.   AKA             2:343/116.117@fidonet.org
  964.   Baud            28800
  965.   Time            1440
  966.   RequestList     c:\jfreq\fich.req
  967.   ResponseList    c:\jfreq\trans.req
  968.   RemoteStatus    unprotected
  969.   SystemStatus    listed
  970.   ----> end srif.nfo <----
  971.  
  972.   b)  Create  another  ASCII  file  that  matches  the  one  entered  in  the
  973.   'RequestList' field above, which will contain the files to request:
  974.  
  975.   ----> begin fich.req <----
  976.   FILES
  977.   %TIC=TESTS
  978.   %PWD=MY_KEY
  979.   MYGIRL.GIF
  980.   MAX300?.*
  981.   ----> end fich.req <----
  982.  
  983.   c) Execute JFReq by using the following command line:
  984.  
  985.       JFREQ /SRIF srif.nfo
  986.  
  987.   d) If you followed the example, you will have  in  the  JFReq  directory  a
  988.   file  named  TRANS.REQ,  that will contain the full path to the files to be
  989.   sent, including a .PKT file  and,  if  activated,  the  corresponding  .TIC
  990.   files  for  the  files requested.  You can inspect those .PKT and TIC files
  991.   to trace the program execution.  You can also check JFReq's LOG.
  992.  
  993.  
  994.   3.13 Credits
  995.  
  996.   Many thanks to all my betatesters, and to their suggestions:
  997.  
  998.   Ignacio Plasencia         Rafael Gutiérrez
  999.   Rafael Suárez             Fidel León
  1000.  
  1001.   Chapter 3. Other data                                                    17
  1002.  
  1003.  
  1004.   Francisco Sedano          Tony Saá
  1005.   David Sáez                Eduard Sánchez Biete
  1006.   Tirs Abril                Carlos Hermida
  1007.   José Gonzalvo             Jose Luis Hernández
  1008.   Dave Carter
  1009.   (and some more I sure forget...)
  1010.  
  1011.  
  1012.   3.14 How to contact the author
  1013.  
  1014.   Please send all your constructive comments on  JFReq  via  electronic  mail
  1015.   to:
  1016.  
  1017.   Jordi Sese,
  1018.   BlackAdders' BBS: INT+34-3-2103303 (24Hr, V34, VFC, FAX)
  1019.   Fidonet:     2:343/116
  1020.   RedBBS:      757:101/25
  1021.   Internet:    shel@black.lonestar.es
  1022.  
  1023.   or by slow surface mail:
  1024.  
  1025.   Jordi Sese
  1026.   C/ Sostres 31, Atico 1
  1027.   08024 Barcelona
  1028.   (Spain)
  1029.  
  1030.   If  you  are  a  registered user, you can use these same media to ask those
  1031.   questions to make your system work better with  JFReq.   If  you  have  not
  1032.   registered  your  program  yet, please take a look at the file REGISTER.TXT
  1033.   to know the conditions of use and how to become a registered user.
  1034.  
  1035.                              - End of JFReq.Doc -
  1036.